home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio / Ham Radio CD-ROM (Emerald Software) (1995).ISO / bbs / bpq402a / ports.doc < prev    next >
Text File  |  1990-10-16  |  10KB  |  388 lines
  1. Configuration file - BPQCFG.TXT
  2.  
  3.  
  4.  
  5. PORTS Section.
  6.  
  7.  
  8. This section of the configuration file defines the links from the switch
  9. to the outside world. These will normally be Radio links, but could also
  10. be a link to another computer running another copy of the switch, or similar
  11. software (eg NOS).
  12.  
  13. Please note that there is no relationship between the 'Virtual' COM ports
  14. defined in the TNCPORT section, which are used by the BBS or other program
  15. running abouve the switch, and these external links. You may use your 
  16. 'real' COM1 port to connect to a KISS TNC, even if you have defined a 
  17. 'Virtual' COM1 in the TNCPORT section. 
  18.  
  19.  
  20. There are two basic classes of links supported by the switch. One uses 
  21. normal ASYNC ports to communicate with TNCs running in KISS mode, and the
  22. other uses special HDLC cards which fit inside the PC. ASYNC links are
  23. supported , and interface to
  24. the radio via either an inbuilt or external modem. Those currently supported
  25. are the PacCom PC120, DRSI PC-PA, and Thor RLC100.
  26.  
  27.  
  28. Interrupt levels may be shared by any cards with suitable hardware.
  29. Examples are all but the earliest DRSI cards, and a MS400 ASYNC card 
  30. modified as described by AA4RE in his MBBIOS documentation. However
  31. there is a significant overhead in using the shared interrupt feature
  32. - try to use it on relatively low speed links, and watch out for TX
  33. underruns/RX overuns.
  34.  
  35.  
  36. Each port is defined by a set of statements of the form:
  37.  
  38.  
  39. PORT
  40.  
  41.     PARAM=VALUE
  42.     ..
  43.     ..
  44.  
  45. ENDPORT
  46.  
  47.  
  48. Samples of various configurations are given later, but the full list
  49. of PARAM values supported is given below
  50.  
  51.  
  52. PORTNUM=n    ; Number for use in PORTS display, connects, etc.
  53.         ; Default is next sequential number.
  54.  
  55. ID=text string *; Up to 30 chars, appears on PORTS display
  56.  
  57. TYPE=ASYNC/DRSI/PC120/RLC100/QUAD/INTERNAL *
  58.  
  59.         ; ASYNC is for a normal ASYNC card, or a shared interrupt card 
  60.         ; such as the MS400
  61.  
  62.         ; PC120, DRSI and RLC100 are the internal HDLC cards - and
  63.         ; support 2 channels.
  64.  
  65.         ; QUAD is the Quadram Quadport, which allows up to 5 async
  66.         ; links. This version only supports a single Quadport. See
  67.         ; later section for setup details.
  68.  
  69.         ; INTERNAL defines a 'loopback' port - anything
  70.         ; sent on it will be received.Intended to allow KISS
  71.         ; applications (eg TCP/IP) to talk to the switch.
  72.  
  73. PROTOCOL=HDLC/KISS/ASYNC/MULTIKISS *
  74.  
  75.         ; ASYNC is NETROM backend link
  76.         ; MULTIKISS is for multidropped    KISS TNCs on one port, and
  77.         ; needs special ROMS (JKISSP), and a diode coupler.
  78.  
  79. IOADDR=xxxH *    ; in hex, H is needed
  80.  
  81. INTLEVEL=n *    ; 2,3,4,5 or 7 - supports shared interrupt cards
  82.  
  83. SPEED=nnnn *    ; Radio speed for DRSI, etc, async link speed for KISS
  84.         ; If set to zero, the modem must supply a 1x clock. 
  85.         ; (TXC on RTXC pin, RXC on TRXC pin.)
  86.  
  87. CHANNEL=A/B/..*    ; Selects port on DRSI/PC120, dual port KISS (eg KPC4) or
  88.         ; MULTIKISS
  89.  
  90. BBSFLAG=NOBBS    ; Stops direct connects to the BBS on this port
  91.  
  92. QUALITY=nnn *    ; Default quality for nodes heard on this port. Set to zero
  93.         ; to suppress NODES broadcasts on this port.
  94.  
  95. MAXFRAME=n *    ; Maximum outstanding frames
  96.  
  97. TXDELAY=nnn *    ; TX Keyup delay in milliseconds
  98.  
  99. SLOTTIME=100 *    ; CSMA interval timer (milliseconds)
  100.  
  101. PERSIST=nnn *    ; 'Probability to transmit' value (1-255)
  102.  
  103. FULLDUP=0/1    ; currently only used by KISS driver
  104.  
  105. SOFTDCD=0/1    ; not yet supported
  106.  
  107. TXTAIL=nnnn    ; TXTAIL timer in ms. Used only by KISS TNCs
  108.  
  109. FRACK=nnnn *    ; Level 2 timout in milliseconds
  110.  
  111. RESPTIME=nnnn *    ; Level 2 delayed ack timer in milliseconds
  112.  
  113. RETRIES=n *    ; Level 2 maximum retry value
  114.  
  115. PACLEN=nnn *    ; default maximum packet length for this port
  116.  
  117. CWID=CALL    ; Currently only supported on DRSI/PC120/RLC100 
  118.  
  119. PORTCALL=CALL    ; Additional callsign/alias for level 2 connects to the
  120. PORTALIAS=ALIAS ; node for this port. Should not be the same as BBSCALL
  121.  
  122. ALIAS_IS_BBS=0/1; If set then PORTCALL and PORTALIAS give access to the BBS
  123.         ; rather than the node. 
  124.  
  125. VALIDCALLS=CALLS; Up to about 40 callsigns, separated by a single commas.
  126.         ; If present, only stations in the list will be allowed
  127.         ; to connect to you on this port. The SSID should not 
  128.         ; be specified, and multiple VALIDCALLS lines may be 
  129.         ; included. End all but he last line with commas. The
  130.         ; total length of the list, including commas, as 256 bytes.
  131.  
  132. QUALADJUST=NNN    ; Percentage to reduce the quality of a NODE in the NODES 
  133.         ; broadcast, if the best neighbour is on the same port as
  134.         ; the broadcast. Designed to improve throughput if more than
  135.         ; one channel is available, by discouraging routes which 
  136.         ; cause a node to send a packet on the same port that it
  137.         ; received it on.
  138.  
  139.  
  140. DIGIFLAG=0/1/255; Digipeat control flag for this port
  141.         ; 0 = dont digi, 1 = digi everything, 255 = digi UI frames only
  142.  
  143.  
  144. DIGIPORT=N    ; Port to send digied frames on. Zero means the port it was
  145.         ; received on, any other number means send on that port. 
  146.         ; This is intended mainly to allow a BBS on another machine,
  147.         ; connected via a wire link, to send out 'MAIL FOR' messages.
  148.  
  149.  
  150. USERS=N        ; This limits the number of L2 sessions to the supplied 
  151.         ; number. Zero means no limit. The limit applies to all
  152.         ; L2 sessions (even those with other nodes), but is only
  153.         ; checked for incoming connects (ie you can make outgoing
  154.         ; connects even when the limit is reached). Intended mainly
  155.         ; to control the number of users on busy user access ports
  156.         ; (especially 2m)
  157.  
  158.  
  159. UNPROTO=    ; Unproto destination and digi string for this port. 
  160.         ; Use commas between calls, and dont include the VIA.
  161.  
  162. L3ONLY=0/1    ; If set, will stop users (but not HOST sessions) issuing
  163.         ; downlink connects on this port. 
  164.  
  165. INTERLOCK=n    ; Allows groups of ports to be defined which will not transmit
  166.         ; at the same time. A value of zero indicates no locking, if
  167.         ; any other value is specifed the code will make sure that no
  168.         ; two ports with the same value can transmit at the same time.
  169.  
  170.  
  171.  
  172.  
  173. Those marked with a * must be included, the rest are optional. The validation
  174. is not good, and defaults are generally zero, so if you miss out any of the
  175. essential ones, odd things may well happen!
  176.  
  177.  
  178.  
  179. Sample PORT Configurations:
  180.  
  181.  
  182. 1. 2 Port DRSI card set for IO addr = 300h, int level 5
  183.  
  184.  
  185. PORT
  186.     ID=144.650 MHz 1200 Baud
  187.     TYPE=DRSI
  188.     PROTOCOL=HDLC
  189.     IOADDR=300H
  190.     INTLEVEL=5
  191.     SPEED=1200
  192.     CHANNEL=A
  193.     QUALITY=10
  194.     MAXFRAME=1
  195.     TXDELAY=500
  196.     SLOTTIME=100
  197.     PERSIST=64
  198.     FULLDUP=0
  199.     SOFTDCD=0
  200.     FRACK=7000
  201.     RESPTIME=2000
  202.     RETRIES=10
  203.     PACLEN=120
  204.     CWID=G8BPQ
  205.  
  206. ENDPORT
  207. ;
  208. PORT
  209.     ID=432.675 MHz 1200 Baud
  210.     TYPE=DRSI
  211.     PROTOCOL=HDLC
  212.     IOADDR=300H
  213.     INTLEVEL=5
  214.     SPEED=1200
  215.     CHANNEL=B
  216.     BBSFLAG=NOBBS            ; IF MY BBS LICENCE IS ONLY FOR 2M
  217.     QUALITY=10
  218.     MAXFRAME=1
  219.     TXDELAY=500
  220.     SLOTTIME=100
  221.     PERSIST=64
  222.     FULLDUP=0
  223.     SOFTDCD=0
  224.     FRACK=6000
  225.     RESPTIME=1500
  226.     RETRIES=10
  227.     PACLEN=120
  228.     CWID=G8BPQ
  229.     PORTCALL=G8BPQ
  230.     PORTALIAS=NOTTM
  231. ;
  232. ENDPORT
  233.  
  234.  
  235. 2. Standard KISS TNC on primary ASYNC card. (COM1). To use the secondary
  236.    ASYNC card (COM2), change IOADDR to 2F8H, and the INTLEVEL to 3.  
  237.  
  238.  
  239. PORT
  240.     ID=144.650 Mhz 1200 Baud
  241.     TYPE=ASYNC
  242.     PROTOCOL=KISS
  243.     IOADDR=3F8H
  244.     INTLEVEL=4
  245.     SPEED=9600
  246.     CHANNEL=A
  247.     QUALITY=10
  248.     MAXFRAME=2
  249.     TXDELAY=500
  250.     SLOTTIME=100
  251.     PERSIST=64
  252.     FULLDUP=0
  253.     FRACK=7000
  254.     RESPTIME=2000
  255.     RETRIES=10
  256.     PACLEN=120
  257.  
  258. ENDPORT
  259.  
  260. The second port of a multiport TNC (Such as the KAM or KPC 4) is defined as
  261. follows:
  262.  
  263.     ID=432.675 Mhz 1200 baud
  264.     TYPE=ASYNC
  265.     PROTOCOL=KISS
  266.     IOADDR=3F8H
  267.     INTLEVEL=4
  268.     SPEED=2400
  269.     CHANNEL=B
  270.     QUALITY=10
  271.     MAXFRAME=2
  272.     TXDELAY=500
  273.     SLOTTIME=100
  274.     PERSIST=64
  275.     FULLDUP=0
  276.     FRACK=7000
  277.     RESPTIME=2000
  278.     RETRIES=10
  279.     PACLEN=120
  280.     QUALADJUST=5
  281.  
  282. ENDPORT
  283.  
  284.  
  285.  
  286. 3. Quadram Quadport.
  287.  
  288. The Quadram Quadport card supports up to 5 (yes I know it says quadport!!)
  289. async ports. This version only supports one card - if anyone needs more,
  290. let me know. You do not need to define all ports, but you must start with
  291. the first, and not leave any gaps.
  292.  
  293. The card should be configured with first port at 280h, and software 
  294. selectable interrupts (3 or 4 may be used)
  295.  
  296. The card will support KISS TNCS (either normal, or KPC4 type dual port), or
  297. NETROM links (or a combination of both). 
  298.  
  299.  
  300. The following sample config file is for a Dual Port KPC4 on channel 1,
  301. a normal KISS TNC on channel 2, and a NETROM async link on channel 3.
  302.  
  303.  
  304. PORT
  305.     ID=KPC4 PORT 1
  306.     TYPE=QUAD
  307.     PROTOCOL=KISS
  308.     IOADDR=280H
  309.     INTLEVEL=3
  310.     SPEED=2400
  311.     CHANNEL=A
  312.     QUALITY=10
  313.     MAXFRAME=2
  314.     TXDELAY=500
  315.     SLOTTIME=100
  316.     PERSIST=64
  317.     FULLDUP=0
  318.     FRACK=7000
  319.     RESPTIME=2000
  320.     RETRIES=10
  321.     PACLEN=120
  322.  
  323. ENDPORT
  324.  
  325. PORT
  326.     ID=KPC4 PORT 2
  327.     TYPE=QUAD
  328.     PROTOCOL=KISS
  329.     IOADDR=280H
  330.     INTLEVEL=3
  331.     SPEED=2400
  332.     CHANNEL=B
  333.     QUALITY=10
  334.     MAXFRAME=2
  335.     TXDELAY=500
  336.     SLOTTIME=100
  337.     PERSIST=64
  338.     FULLDUP=0
  339.     FRACK=7000
  340.     RESPTIME=2000
  341.     RETRIES=10
  342.     PACLEN=120
  343.  
  344. ENDPORT
  345.  
  346. PORT
  347.     ID=NORMAL KISS
  348.     TYPE=QUAD
  349.     PROTOCOL=KISS
  350.     IOADDR=290H
  351.     INTLEVEL=3
  352.     SPEED=2400
  353.     CHANNEL=A
  354.     QUALITY=10
  355.     MAXFRAME=2
  356.     TXDELAY=500
  357.     SLOTTIME=100
  358.     PERSIST=64
  359.     FULLDUP=0
  360.     FRACK=7000
  361.     RESPTIME=2000
  362.     RETRIES=10
  363.     PACLEN=120
  364.  
  365. ENDPORT
  366.  
  367. PORT
  368.     ID=NETROM BACKEND
  369.     TYPE=QUAD
  370.     PROTOCOL=NETROM
  371.     IOADDR=2A0H
  372.     INTLEVEL=3
  373.     SPEED=2400
  374.     CHANNEL=A
  375.     QUALITY=10
  376.     MAXFRAME=2
  377.     TXDELAY=500        ; THESE AREN'T USED, BUT I SUGGEST  
  378.     SLOTTIME=100        ; YOU PUT THEM IN IN CASE ONE DAY
  379.     PERSIST=64        ; THEY ARE!
  380.     FULLDUP=1        ;
  381.     SOFTDCD=0
  382.     FRACK=7000
  383.     RESPTIME=2000
  384.     RETRIES=10
  385.     PACLEN=120
  386.  
  387. ENDPORT
  388.